UserTokenCredentials

The user credentials for authentication by token.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

token

The administrative authority token - generated by by an administrator using normal authentication methods first.

Y

string

userIdentity

The user's login identity. The format depends on the authentication provider: Its 'username' for internal database authentication. For AD, its either UPN or 'domain\\username'. For SAML its UPN.

Y

string

customData

Custom data input for usage within the product.

-

string

*Required elements are only used for API parameters

Usages
  • /API2/auth/authenticateUserByToken
  • /API2/auth/authenticateUserEmbedByToken